home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1990: Discy Business / Discy Business.2mg / DEV.CD / TOOLS / CLIBS / LIBRARIES / CINCLUDE / PRODOS.H < prev    next >
Encoding:
C/C++ Source or Header  |  1988-08-01  |  12.4 KB  |  405 lines  |  [B0] Apple IIgs Source Code (0x000A)
  1. /******************************************** 
  2. ; File: ProDos.h 
  3. ; 
  4. ; 
  5. ; Copyright Apple Computer, Inc. 1986, 1987, 1988 
  6. ; All Rights Reserved 
  7. ; 
  8. ********************************************/ 
  9.  
  10. #ifndef __types__ 
  11. #include <types.h> 
  12. #endif 
  13.  
  14. #ifndef __prodos__ 
  15. #define __prodos__ 
  16.  
  17. #ifdef __GSOS__ 
  18.  
  19. #undef GetSysPrefs 
  20. #undef BeginSession 
  21. #undef EndSession 
  22. #undef SessionStatus 
  23. #undef ResetCache 
  24. #undef ChangePath 
  25. #undef ClearBackupBit 
  26. #undef Close 
  27. #undef Create 
  28. #undef DControl 
  29. #undef Destroy 
  30. #undef DInfo 
  31. #undef DRead 
  32. #undef DStatus 
  33. #undef DWrite 
  34. #undef EraseDisk 
  35. #undef ExpandPath 
  36. #undef Flush 
  37. #undef Format 
  38. #undef GetBootVol 
  39. #undef GetDevNumber 
  40. #undef GetDirEntry 
  41. #undef GetEOF 
  42. #undef GetFileInfo 
  43. #undef GetFSTInfo 
  44. #undef GetLevel 
  45. #undef GetMark 
  46. #undef GetName 
  47. #undef GetPrefix 
  48. #undef GetVersion 
  49. #undef Newline 
  50. #undef Null 
  51. #undef Open 
  52. #undef Quit 
  53. #undef Read 
  54. #undef SetEOF 
  55. #undef SetFileInfo 
  56. #undef SetLevel 
  57. #undef SetMark 
  58. #undef SetPrefix 
  59. #undef UnbindInt 
  60. #undef Volume 
  61. #undef Write 
  62. #undef BindInt 
  63. #undef ChangePath 
  64. #undef ClearBackupBit 
  65. #undef Close 
  66. #undef Create 
  67. #undef DControl 
  68. #undef Destroy 
  69. #undef DInfo 
  70. #undef DRead 
  71. #undef DStatus 
  72. #undef DWrite 
  73. #undef EraseDisk 
  74. #undef ExpandPath 
  75. #undef Flush 
  76. #undef Format 
  77. #undef GetBootVol 
  78. #undef GetDevNumber 
  79. #undef GetDirEntry 
  80. #undef GetEOF 
  81. #undef GetFileInfo 
  82. #undef GetFSTInfo 
  83. #undef GetLevel 
  84. #undef GetMark 
  85. #undef GetName 
  86. #undef GetPrefix 
  87. #undef GetVersion 
  88. #undef Newline 
  89. #undef Null 
  90. #undef Open 
  91. #undef Quit 
  92. #undef Read 
  93. #undef SetEOF 
  94. #undef SetFileInfo 
  95. #undef SetLevel 
  96. #undef SetMark 
  97. #undef SetPrefix 
  98. #undef UnbindInt 
  99. #undef Volume 
  100. #undef Write 
  101.  
  102. #undef ChangePathRec  
  103. #undef CreateRec  
  104. #undef DAccessRec  
  105. #undef DevNumRec  
  106. #undef DInfoRec  
  107. #undef DIORec  
  108. #undef DirEntryRec  
  109. #undef ExpandPathRec  
  110. #undef FileInfoRec  
  111. #undef FormatRec  
  112. #undef FSTInfoRec  
  113. #undef InterruptRec  
  114. #undef IORec  
  115. #undef LevelRec  
  116. #undef NameRec  
  117. #undef NewlineRec  
  118. #undef OpenRec  
  119. #undef PositionRec  
  120. #undef PrefixRec  
  121. #undef QuitRec  
  122. #undef RefNumRec  
  123. #undef SetPositionRec  
  124. #undef SysPrefRec  
  125. #undef VersionRec  
  126. #undef VolumeRec  
  127. #undef DInfoRec  
  128. #undef FSTInfoRec  
  129. #undef OpenRec  
  130. #undef VersionRec 
  131.  
  132. #endif 
  133.  
  134.  
  135. #define invalidCallNum       0x01 /* error - invalid call number */
  136. #define unclaimedIntErr      0x01 /* error - fatal error - unclaimed interrupt */
  137. #define badPBlockPtr         0x05 /* error - call pointer out of bounds */
  138. #define pdosActiveErr        0x06 /* error - ProDOS is active */
  139. #define pdosBusyErr          0x07 /* error - ProDos is busy   */
  140. #define vcbUnusable          0x0A /* error - fatal error - VCB unusable */
  141. #define fcbUnusable          0x0B /* error - fatal error - FCB unusable */
  142. #define badBlockZero         0x0C /* error - fatal error - block zero allocated illegally */
  143. #define shdwInterruptErr     0x0D /* error - fatal error - interrupt occured while I/O shadowing off */
  144. #ifndef devNotFound /* error - device not found */
  145. #define devNotFound          0x10 
  146. #endif 
  147. #define badDevRefNum         0x11 /* error - invalid device reference number */
  148. #define osVersionErr         0x11 /* error - Wrong OS version  */
  149. #define badReqCode           0x20 /* error - invalid request code */
  150. #define intTableFull         0x25 /* error - interrupt table full */
  151. #define invalidOperation     0x26 /* error - invalid operation */
  152. #define ioError              0x27 /* error - I/O error */
  153. #define noDevConnect         0x28 /* error - no device connected */
  154. #define writeProtectErr      0x2B /* error - write protect error */
  155. #define diskSwitchErr        0x2E /* error - disk switched error */
  156. #define badPathName          0x40 /* error - invalid pathname syntax */
  157. #define fcbFullErr           0x42 /* error - FCB full error */
  158. #define badFileRefNum        0x43 /* error - invalid file reference number */
  159. #ifndef pathNotFound /* error - path not found */
  160. #define pathNotFound         0x44 
  161. #endif 
  162. #define volumeNotFound       0x45 /* error - volume not found */
  163. #ifndef fileNotFound /* error - file not found */
  164. #define fileNotFound         0x46 
  165. #endif 
  166. #define dupFileName          0x47 /* error - duplicate file name */
  167. #define volumeFullErr        0x48 /* error - volume full error */
  168. #define dirFullErr           0x49 /* error - directory full error */
  169. #define versionErr           0x4A /* error - version error (incompatible file format) */
  170. #ifndef badStoreType /* error - unsupported (or incorrect) storage type */
  171. #define badStoreType         0x4B 
  172. #endif 
  173. #ifndef eofEncountered /* error - end-of-file encountered */
  174. #define eofEncountered       0x4C 
  175. #endif 
  176. #define positionRangeErr     0x4D /* error - position out of range */
  177. #define accessErr            0x4E /* error - access not allowed */
  178. #define fileOpenErr          0x50 /* error - file is open */
  179. #define dirDamaged           0x51 /* error - directory structure is damaged */
  180. #define badVolType           0x52 /* error - unsupported volume type */
  181. #ifndef paramRangeErr /* error - parameter out of range */
  182. #define paramRangeErr        0x53 
  183. #endif 
  184. #define memoryFullErr        0x54 /* error - out of memory */
  185. #define vcbFullErr           0x55 /* error - VCB full error */
  186. #define dupVolumeErr         0x57 /* error - duplicate volume error */
  187. #define notBlkDevErr         0x58 /* error - not a blocked device */
  188. #ifndef invalidLevel /* error - invalid level */
  189. #define invalidLevel         0x59 
  190. #endif 
  191. #define blkNumRangeErr       0x5A /* error - block number out of range */
  192. #define notSameVolErr        0x5B /* error - different volumes found on ChangePath call */
  193. #define notExecSysFile       0x5C /* error - not an executable system file */
  194. #define osUnavailable        0x5D /* error - Operating system unavailable*/
  195. #define deallocateRamErr     0x5E /* error - Cannot deallocate /RAM     */
  196. #ifndef stackOverflow /* error - Return stack overflow      */
  197. #define stackOverflow        0x5F 
  198. #endif 
  199. #define dataUnavailable      0x60 /* error - Data unavailable           */
  200.  
  201. #define endofDirectory 0x0061 /*GetDirEntry -  */
  202.  
  203.  /* ProDOS Interface */
  204.  
  205. #define P_READ_ENABLE     1 
  206. #define P_WRITE_ENABLE    2 
  207. #define P_DESTROY_ENABLE  (1<<7) 
  208. #define P_RENAME_ENABLE   (1<<6) 
  209.  
  210.  /* for ReadBlock, WriteBlock */
  211.  
  212. typedef struct BlockRec { 
  213.      Word     blockDevNum; /* BlockRec -   */
  214.      Ptr      blockDataBuffer; /* BlockRec -   */
  215.      Longint  blockNum; /* BlockRec -   */
  216.      } BlockRec, *BlockRecPtr, **BlockRecHndl; 
  217.  
  218.  /* for GetDevNum */
  219.  
  220. typedef struct DevNumRec { 
  221.      Ptr      devName; /* DevNumRec -   */
  222.      Word     devNum; /* DevNumRec -   */
  223.     } DevNumRec, *DevNumRecPtr, **DevNumRecHndl; 
  224.  
  225.  /* for SetEOF, GetEOF */
  226.  
  227. typedef struct EOFRec { 
  228.      Word     eofRefNum; /* EOFRec -   */
  229.      Longint  eofPosition; /* EOFRec -   */
  230.     } EOFRec, *EOFRecPtr, **EOFRecHndl; 
  231.  
  232.  /* for Read, Write, Close, Flush */
  233.  
  234. typedef struct FileIORec { 
  235.      Word     fileRefNum; /* FileIORec -   */
  236.      Ptr      dataBuffer; /* FileIORec -   */
  237.      Longint  requestCount; /* FileIORec -   */
  238.      Longint  transferCount; /* FileIORec -   */
  239.     } FileIORec, *FileIORecPtr, **FileIORecHndl; 
  240.  
  241.  /* for Create, SetFileInfo, GetFileInfo */
  242.  
  243. typedef struct FileRec { 
  244.      Ptr     pathname; /* FileRec -   */
  245.      Word     fAccess; /* FileRec -   */
  246.      Word     fileType; /* FileRec -   */
  247.      Longint     auxType; /* FileRec -   */
  248.      Word     storageType; /* FileRec -   */
  249.      Word     createDate; /* FileRec -   */
  250.      Word     createTime; /* FileRec -   */
  251.      Word     modDate; /* FileRec -   */
  252.      Word     modTime; /* FileRec -   */
  253.      Long     blocksUsed; /* FileRec -   */
  254.     } FileRec, *FileRecPtr, **FileRecHndl; 
  255.  
  256.  /* for AllocInterrupt, DeallocInterrupt */
  257.  
  258. typedef struct InterruptRec { 
  259.      Word     intNum; /* InterruptRec -   */
  260.      Ptr      intCode; /* InterruptRec -   */
  261.     } InterruptRec, *InterruptRecPtr, **InterruptRecHndl; 
  262.  
  263.  /* for SetLevel, GetLevel */
  264.  
  265. typedef struct LevelRec { 
  266.      Word     level; /* LevelRec -   */
  267.     } LevelRec, *LevelRecPtr, **LevelRecHndl; 
  268.  
  269.  /* for SetMark, GetMark */
  270.  
  271. typedef struct MarkRec { 
  272.      Word     markRefNum; /* MarkRec -   */
  273.      Long     position; /* MarkRec -   */
  274.     } MarkRec, *MarkRecPtr, **MarkRecHndl; 
  275.  
  276.  /* for NewLine */
  277.  
  278. typedef struct NewlineRec { 
  279.      Word     newLRefNum; /* NewlineRec -   */
  280.      Word     enableMask; /* NewlineRec -   */
  281.      Word     newlineChar; /* NewlineRec -   */
  282.     } NewlineRec, *NewlineRecPtr, **NewlineRecHndl; 
  283.  
  284.  /* for Open */
  285.  
  286. typedef struct OpenRec { 
  287.      Word     openRefNum; /* OpenRec -   */
  288.      Ptr      openPathname; /* OpenRec -   */
  289.      Handle   ioBuffer; /* OpenRec -   */
  290.     } OpenRec, *OpenRecPtr, **OpenRecHndl; 
  291.  
  292.  /* for Destroy, ChangePath, ClearBackupBit, GetPathname, GetBootVol */
  293.  
  294. typedef struct PathNameRec { 
  295.      Ptr      pathname; /* PathNameRec -   */
  296.      Ptr      newPathname; /* PathNameRec -   */
  297.     } PathNameRec, *PathNameRecPtr, **PathNameRecHndl; 
  298.  
  299.  /* for SetPrefix, GetPrefix */
  300.  
  301. typedef struct PrefixRec { 
  302.      Word     prefixNum; /* PrefixRec -   */
  303.      Ptr      prefix; /* PrefixRec -   */
  304.     } PrefixRec, *PrefixRecPtr, **PrefixRecHndl; 
  305.  
  306.  /* for GetVersion */
  307. typedef struct VersionRec { 
  308.      Word     version; /* VersionRec -   */
  309.     } VersionRec, *VersionRecPtr, **VersionRecHndl; 
  310.  
  311.  /* for Volume */
  312.  
  313. typedef struct VolumeRec { 
  314.      Ptr      deviceName; /* VolumeRec -   */
  315.      Ptr      volName; /* VolumeRec -   */
  316.      Long     totalBlocks; /* VolumeRec -   */
  317.      Long     freeBlocks; /* VolumeRec -   */
  318.      Word     fileSysID; /* VolumeRec -   */
  319.     } VolumeRec, *VolumeRecPtr, **VolumeRecHndl; 
  320.  
  321.  /* for Format */
  322. typedef struct FormatRec { 
  323.    Ptr      devName; 
  324.    Ptr      volName; 
  325.    word  fileSysID; 
  326.    } FormatRec, *FormatRecPtr, **FormatRecHndl; 
  327.  
  328.  /* for Erase_Disk   */
  329. typedef FormatRec EraseDiskRec, *EraseDiskRecPtr, **EraseDiskRecHndl; 
  330.  
  331.  /* for Quit */
  332. typedef struct QuitRec { 
  333.    Ptr      quitPathname; 
  334.    Word  flags; 
  335.    } QuitRec, *QuitRecPtr, **QuitRecHndl; 
  336.  
  337.  /* for DInfo */
  338. typedef struct DInfoRec { 
  339.    Word devNum; 
  340.    Ptr  devName; 
  341.    } DInfoRec, *DInfoRecPtr, **DInfoRecHndl; 
  342.  
  343. typedef struct DirEntryRec { 
  344.    Word  refNum; 
  345.    Word  reserved; /* must be 0x0000 */
  346.    Word  base; 
  347.    Word  displacement; 
  348.    Ptr      nameBuffer; 
  349.    Word  entryNum; 
  350.    Word  fileType; 
  351.    Long  endOfFile; 
  352.    LongWord blockCount; 
  353.    TimeRec createTime; 
  354.    TimeRec modTime; 
  355.    Word  access; 
  356.    LongWord auxType; 
  357.    Word  fileSysID; 
  358.    } DirEntryRec, *DirEntryRecPtr, **DirEntryRecHndl; 
  359.  
  360. #define CREATE(pBlockPtr) (PDosInt(1,pBlockPtr)) 
  361. #define DESTROY(pBlockPtr) (PDosInt(2,pBlockPtr)) 
  362. #define CHANGE_PATH(pBlockPtr) (PDosInt(4,pBlockPtr)) 
  363. #define SET_FILE_INFO(pBlockPtr) (PDosInt(5,pBlockPtr)) 
  364. #define GET_FILE_INFO(pBlockPtr) (PDosInt(6,pBlockPtr)) 
  365. #define VOLUME(pBlockPtr) (PDosInt(8,pBlockPtr)) 
  366. #define SET_PREFIX(pBlockPtr) (PDosInt(9,pBlockPtr)) 
  367. #define GET_PREFIX(pBlockPtr) (PDosInt(10,pBlockPtr)) 
  368. #define CLEAR_BACKUP_BIT(pBlockPtr) (PDosInt(11,pBlockPtr)) 
  369. #define OPEN(pBlockPtr) (PDosInt(16,pBlockPtr)) 
  370. #define NEWLINE(pBlockPtr) (PDosInt(17,pBlockPtr)) 
  371. #define READ(pBlockPtr) (PDosInt(18,pBlockPtr)) 
  372. #define WRITE(pBlockPtr) (PDosInt(19,pBlockPtr)) 
  373. #define CLOSE(pBlockPtr) (PDosInt(20,pBlockPtr)) 
  374. #define FLUSH(pBlockPtr) (PDosInt(21,pBlockPtr)) 
  375. #define SET_MARK(pBlockPtr) (PDosInt(22,pBlockPtr)) 
  376. #define GET_MARK(pBlockPtr) (PDosInt(23,pBlockPtr)) 
  377. #define SET_EOF(pBlockPtr) (PDosInt(24,pBlockPtr)) 
  378. #define GET_EOF(pBlockPtr) (PDosInt(25,pBlockPtr)) 
  379. #define SET_LEVEL(pBlockPtr) (PDosInt(26,pBlockPtr)) 
  380. #define GET_LEVEL(pBlockPtr) (PDosInt(27,pBlockPtr)) 
  381. #define GET_DIR_ENTRY(pBlockPtr) (PDosInt(28,pBlockPtr)) 
  382. #define GET_DEV_NUM(pBlockPtr) (PDosInt(32,pBlockPtr)) 
  383. #define GET_LAST_DEV(pBlockPtr) (PDosInt(33,pBlockPtr)) 
  384. #define READ_BLOCK(pBlockPtr) (PDosInt(34,pBlockPtr)) 
  385. #define WRITE_BLOCK(pBlockPtr) (PDosInt(35,pBlockPtr)) 
  386. #define FORMAT(pBlockPtr) (PDosInt(36,pBlockPtr)) 
  387. #define ERASE_DISK(pBlockPtr) (PDosInt(37,pBlockPtr)) 
  388. #define GET_NAME(pBlockPtr) (PDosInt(39,pBlockPtr)) 
  389. #define GET_PATH_NAME(pBlockPtr) (PDosInt(39,pBlockPtr)) 
  390. #define GET_BOOT_VOL(pBlockPtr) (PDosInt(40,pBlockPtr)) 
  391. #define QUIT(pBlockPtr) (PDosInt(41,pBlockPtr)) 
  392. #define GET_VERSION(pBlockPtr) (PDosInt(42,pBlockPtr)) 
  393. #define D_INFO(pBlockPtr) (PDosInt(44,pBlockPtr)) 
  394. #define ALLOC_INTERRUPT(pBlockPtr) (PDosInt(49,pBlockPtr)) 
  395. #define DEALLOC_INTERRUPT(pBlockPtr) (PDosInt(50,pBlockPtr)) 
  396.  
  397.  /* GSOS.h provides a definition which eliminates glue by using the new Stackbased 
  398.  entry point. Other wise use the PdosInt() glue call                        */
  399. #ifndef __GSOS__ 
  400.  extern pascal void PDosInt(); 
  401. #endif 
  402.  
  403. #endif 
  404.  
  405.